Update rule description #42
Conversation
Reworked the rule description section to include scope and expand on the bullets.
Minor changes to the updated rule description
act-framework.bs
Outdated
| * Explains the failure conditions and their reasons. | ||
| * Is in plain language and provides a brief description of what the rule does. | ||
| * Explains the accessibility requirement being tested such as the WCAG SC or the technique the rule maps to; For example WCAG 2.0 Technique H67. | ||
| * Lists any limitations and assumptions for the test, the test environment, technologies being used or the subject being tested; For example: A rule for 1.4.1: Use of Color has to make an assumption with CSS-properties are used to make a link visually evident. Typically something like background, border, color, font, or text-decoration. |
There was a problem hiding this comment.
Editorial: '...has to make an assumption that CSS properties', don't hyphenate CSS properties, change 'with' to 'that'. The last sentence is missing a verb, so suggest saying 'Typical examples are: background, border, color, font, or text decoration'. Text decoration should not be hyphenated.
act-framework.bs
Outdated
| * Is in plain language and provides a brief description of what the rule does. | ||
| * Explains the accessibility requirement being tested such as the WCAG SC or the technique the rule maps to; For example WCAG 2.0 Technique H67. | ||
| * Lists any limitations and assumptions for the test, the test environment, technologies being used or the subject being tested; For example: A rule for 1.4.1: Use of Color has to make an assumption with CSS-properties are used to make a link visually evident. Typically something like background, border, color, font, or text-decoration. | ||
| * The scope or the context of the rule; |
There was a problem hiding this comment.
Need a verb for this to be consistent. 'Contains the scope or the context of the rule;'
|
This duplicates much of the Rule Outline. The Rule Description should be part of the Rule Outline and in plain language describe what the rule does.. |
|
See PR #43 |
act-framework.bs
Outdated
| * Explains the accessibility requirement being tested such as the WCAG SC or the technique the rule maps to; For example WCAG 2.0 Technique H67. | ||
| * Lists any limitations and assumptions for the test, the test environment, technologies being used or the subject being tested; For example: A rule for 1.4.1: Use of Color has to make an assumption that CSS properties are used to make a link visually evident. Typical examples are: background, border, color, font, or text decoration. | ||
| * Provides the scope or the context of the rule; | ||
| * Explains the failure conditions and their reasons. For example the rule triggers on all images on the page that has no alt attribute defined. |
There was a problem hiding this comment.
the rule triggers on all the images on the page that has no alt attribute defined
do it mean the rule is applied to all such images, or returns a fail to all such images? (in other words, is it an example of the rule scope and context, or of the rule failure condition?)
There was a problem hiding this comment.
This duplicates much of the Rule Outline. The Rule Description should be part of the Rule Outline and in plain language describe what the rule does..
Based on the agreement during the Jan 25 call, removed the additional bullets so as to not duplicate the information in the rule outline.
|
Have pushed changes based on review. |
act-framework.bs
Outdated
| * Lists any limitations and assumptions for the test; | ||
| * Explains the failure conditions and their reasons. | ||
| * Is in plain language and provides a brief description of what the rule does. | ||
| * Explains the accessibility requirement being tested such as the WCAG SC or the technique the rule maps to; For example WCAG 2.0 Technique H67. |
There was a problem hiding this comment.
If I recall correctly, a rule always applies to at least one success criterion, and may map to any number of techniques? If so, should this be separated into two points:
- Lists the accessibility requirement being tested, such as the WCAG Success Criterion
- Refers to any related information, such as the WCAG Techniques it maps to
There was a problem hiding this comment.
Good point Shadi, i will make the suggested changes. Thx.
act-framework.bs
Outdated
| * Explains the accessibility requirement being tested; | ||
| * Lists any limitations and assumptions for the test; | ||
| * Explains the failure conditions and their reasons. | ||
| * Is in plain language and provides a brief description of what the rule does. |
There was a problem hiding this comment.
"a rule must have a description that provides a brief description of what the rule does" sounds a bit tautological 😉.
I'd suggest "provides a summary" or "provides a short explanation" instead.
There was a problem hiding this comment.
Like short explanation, will make the change.
|
Have pushed updates based on review comments. |
updates to the rule description to include scope and expand on the bullets are ready for review.